Changes on nuttx getting started article #364
Conversation
|
@tmedicci, @fdcavalcanti I am open to your suggestions. |
|
LGTM. Waiting for review from @tmedicci or @fdcavalcanti |
|
lgtm as well. |
| @@ -193,9 +193,10 @@ git clone https://github.com/apache/nuttx-apps apps | |||
|
|
|||
| ### Building an App to Connect to a Wi-Fi network | |||
|
|
|||
| NuttX provides ready-to-use board default configurations that enable the required config (from Kconfig) for a use scenario, such as Wi-Fi or I2C. You can list all available configurations for the ESP32 DevKitC V4 board using the following command, inside the NuttX directory: | |||
| NuttX provides ready-to-use board default configurations that enable the required config (from Kconfig) for a use scenario, such as Wi-Fi or I2C. To enter NuttX directory and list all available configurations for the ESP32 DevKitC V4 board you can use the following command: | |||
There was a problem hiding this comment.
Please add a comma. It helps to visually separate the first part of the sentence saying what will happen from the second part of the sentence saying what you need to do to make it happen.
| NuttX provides ready-to-use board default configurations that enable the required config (from Kconfig) for a use scenario, such as Wi-Fi or I2C. To enter NuttX directory and list all available configurations for the ESP32 DevKitC V4 board you can use the following command: | |
| NuttX provides ready-to-use board default configurations that enable the required config (from Kconfig) for a use scenario, such as Wi-Fi or I2C. To enter NuttX directory and list all available configurations for the ESP32 DevKitC V4 board, you can use the following command: |
If I may, I would like to propose further improvements to the sentence. The command cd is self-evident to most people, so the part To enter NuttX directory sounds like partonizing. How about this:
To list all available configurations for the ESP32 DevKitC V4 board, go to your nuttx directory and run:
There was a problem hiding this comment.
How about this:
"To list all available configurations for the ESP32 DevKitC V4 board, go to your nuttxspace directory and run:"
Directory structure looks like this:
.
└── nuttxspace/
├── nuttx
└── apps
If we say go to your nuttx directory, we don't need to add cd nuttx command, I think. Adding cd nuttx command is the main purpose of this PR.
|
@eren-terzioglu Please check my comment, and then let's merge this PR. |
Description
Change on nuttx getting started article. Suggestion came from @georgik
Related
Testing